X User Tools/X User Tools (O'Reilly and Associates)(1994).ISO/sun4c/archive/tcltk.z/tcltk/man/cat3/WindowId.3

Text File | 1994-09-20 | 5.8 KB | 199 lines

Tk_WindowId(3)        Tk Library Procedures



_________________________________________________________________

NAME
     Tk_WindowId,    Tk_Parent,    Tk_Display,    Tk_DisplayName,
     Tk_ScreenNumber, Tk_Screen, Tk_X, Tk_Y, Tk_Width, Tk_Height,
     Tk_Changes,   Tk_Attributes,   Tk_IsMapped,   Tk_IsTopLevel,
     Tk_ReqWidth,      Tk_ReqHeight,      Tk_InternalBorderWidth,
     Tk_Visual, Tk_Depth,  Tk_Colormap   -  retrieve  information
     from Tk's local data structure

SYNOPSIS
     #include <tk.h>

     Window
     Tk_WindowId(_t_k_w_i_n)

     Tk_Window
     Tk_Parent(_t_k_w_i_n)

     Display *
     Tk_Display(_t_k_w_i_n)

     char *
     Tk_DisplayName(_t_k_w_i_n)

     int
     Tk_ScreenNumber(_t_k_w_i_n)

     Screen *
     Tk_Screen(_t_k_w_i_n)

     int
     Tk_X(_t_k_w_i_n)

     int
     Tk_Y(_t_k_w_i_n)

     int
     Tk_Width(_t_k_w_i_n)

     int
     Tk_Height(_t_k_w_i_n)

     XWindowChanges *
     Tk_Changes(_t_k_w_i_n)

     XSetWindowAttributes *
     Tk_Attributes(_t_k_w_i_n)

     int
     Tk_IsMapped(_t_k_w_i_n)




Tk                                                              1






Tk_WindowId(3)        Tk Library Procedures



     int                                                           |
     Tk_IsTopLevel(_t_k_w_i_n)                                          |

     int
     Tk_ReqWidth(_t_k_w_i_n)

     int
     Tk_ReqHeight(_t_k_w_i_n)

     int
     Tk_InternalBorderWidth(_t_k_w_i_n)

     Visual *                                                      |
     Tk_Visual(_t_k_w_i_n)                                              |

     int                                                           |
     Tk_Depth(_t_k_w_i_n)                                               |

     Colormap                                                      |
     Tk_Colormap(_t_k_w_i_n)                                            |

ARGUMENTS
     Tk_Window   _t_k_w_i_n   (in)      Token for window.
_________________________________________________________________


DESCRIPTION
     Tk_WindowID and the other names listed above are all  macros
     that return fields from Tk's local data structure for _t_k_w_i_n.
     None of these  macros  requires  any  interaction  with  the
     server;  it is safe to assume that all are fast.

     Tk_WindowId returns the X identifier for _t_k_w_i_n, or  NULL  if
     no  X  window  has  been  created  for  _t_k_w_i_n  yet  (see the
     Tk_CreateMainWindow manual entry for details).

     Tk_Parent returns Tk's  token  for  the  logical  parent  of
     _t_k_w_i_n.   The  parent  is  the  token that was specified when
     _t_k_w_i_n was created, or NULL for main windows.

     Tk_Display returns a pointer to the Xlib  display  structure
     corresponding  to  _t_k_w_i_n.   Tk_DisplayName  returns an ASCII
     string identifying _t_k_w_i_n's display.  Tk_ScreenNumber returns
     the index of _t_k_w_i_n's screen among all the screens of _t_k_w_i_n's
     display.  Tk_Screen returns a pointer to the Xlib  structure
     corresponding to _t_k_w_i_n's screen.

     Tk_X, Tk_Y, Tk_Width, and Tk_Height return information about
     _t_k_w_i_n'_s  location within its parent and its size.  The loca-
     tion information refers to the upper-left pixel in the  win-
     dow,  or  its  border if there is one.  The width and height
     information refers to the interior size of the  window,  not



Tk                                                              2






Tk_WindowId(3)        Tk Library Procedures



     including  any  border.   Tk_Changes  returns a pointer to a
     structure containing all of the above information plus a few
     other   fields.   Tk_Attributes  returns  a  pointer  to  an
     XSetWindowAttributes structure describing all of the  attri-
     butes  of  the  _t_k_w_i_n's  window,  such as background pixmap,
     event mask, and so on (Tk keeps track of all  this  informa-
     tion  as  it  is  changed  by the application).  Note: it is
     essential  that  applications   use   Tk   procedures   like
     Tk_ResizeWindow  instead of X procedures like XResizeWindow,
     so that Tk can keep its data structures up-to-date.

     Tk_IsMapped returns a non-zero value if _t_k_w_i_n is mapped  and
     zero if _t_k_w_i_n isn't mapped.

     Tk_IsTopLevel returns a non-zero value if _t_k_w_i_n  is  a  top-  |
     level window (its X parent is the root window of the screen)  |
     and zero if _t_k_w_i_n isn't a top-level window.

     Tk_ReqWidth and Tk_ReqHeight return  information  about  the
     window's  requested  size.   These  values correspond to the
     last call to Tk_GeometryRequest for _t_k_w_i_n.

     Tk_InternalBorderWidth returns the width of internal  border
     that  has  been  requested  for  _t_k_w_i_n,  or 0 if no internal
     border was requested.  The return value is simply  the  last
     value passed to Tk_SetInternalBorder for _t_k_w_i_n.

     Tk_Visual,  Tk_Depth,  and  Tk_Colormap  return  information  |
     about  the  visual  characteristics  of a window.  Tk_Visual  |
     returns the visual type for the window, Tk_Depth returns the  |
     number  of  bits  per  pixel,  and  Tk_Colormap  returns the  |
     current colormap for the window.  The visual characteristics  |
     are  normally set from the defaults for the window's screen,  |
     but they may be overridden by calling Tk_SetWindowVisual.


KEYWORDS
     attributes,  colormap,  depth,  display,  height,   geometry
     manager,  identifier,  mapped,  requested size, screen, top-
     level, visual, width, window, x, y















Tk                                                              3